// Copyright 2007 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.enterprise.connector.afyd;

import com.google.enterprise.connector.spi.AuthenticationManager;
import com.google.enterprise.connector.spi.AuthorizationManager;
import com.google.enterprise.connector.spi.Connector;
import com.google.enterprise.connector.spi.DocumentList;
import com.google.enterprise.connector.spi.RepositoryException;
import com.google.enterprise.connector.spi.Session;
import com.google.enterprise.connector.spi.TraversalManager;

import java.util.List;

/**
 * This class services as the Connector, Session, and TraversalManager for the
 * Afyd connector family.  This class can be made to talk to different hosted
 * services by injecting different FeedEntryProviders.
 * 
 * @author amsmith@google.com (Adam Smith)
 */
public class AfydConnector implements Connector, Session, TraversalManager {
  
  public DocumentList list;
  
  public AfydConnector (List users, String propertiesFilename,
      FeedEntryProvider provider) throws RepositoryException {
    this.list = new StatelessDocumentList(users, propertiesFilename, provider);
  }
  
  /** {@inheritDoc} */
  public Session login() {
    return this; // this class behaves as a Session also
  }
  
  /** {@inheritDoc} */
  public AuthenticationManager getAuthenticationManager() {
    return null; // no authentication used
  }
  
  /** {@inheritDoc} */
  public AuthorizationManager getAuthorizationManager() {
    return null; // no authorization used
  }
  
  /** {@inheritDoc} */
  public TraversalManager getTraversalManager() {
    return this; // this class behaves as a TraversalManager also
  }
  
  /**
   * Calls this this method are ignored.  Currently, FeedEntryProvider makes
   * no allowance for the batch hint.
   */
  public void setBatchHint(int batchHint) {
    return;
  }
  
  /** {@inheritDoc} */
  public DocumentList startTraversal() {
    return list;
  }
  
  /**
   * {@inheritDoc}
   * 
   * This connector manages its own checkpoints internally.
   * 
   * @param checkPoint is ignored
   */
  public DocumentList resumeTraversal(String checkPoint) {
    return list;
  }
  
}
